<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AtkStateSet</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="ATK - Accessibility Toolkit">
<link rel="up" href="atk.html" title="ATK Library">
<link rel="prev" href="atk-AtkState.html" title="AtkState">
<link rel="next" href="AtkStreamableContent.html" title="AtkStreamableContent">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="atk.html" title="ATK Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in ATK 1.3">
<link rel="index" href="ix04.html" title="Index of new symbols in ATK 1.4">
<link rel="index" href="ix05.html" title="Index of new symbols in ATK 1.6">
<link rel="index" href="ix06.html" title="Index of new symbols in ATK 1.9">
<link rel="index" href="ix07.html" title="Index of new symbols in ATK 1.12">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="atk-AtkState.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="atk.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">ATK - Accessibility Toolkit</th>
<td><a accesskey="n" href="AtkStreamableContent.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#atk-AtkStateSet.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#atk-AtkStateSet.description" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="atk-AtkStateSet"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="atk-AtkStateSet.top_of_page"></a>AtkStateSet</span></h2>
<p>AtkStateSet — An AtkStateSet determines a component's state set.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="atk-AtkStateSet.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
AtkStateSet*        <a class="link" href="atk-AtkStateSet.html#atk-state-set-new" title="atk_state_set_new ()">atk_state_set_new</a>                   (void);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a class="link" href="atk-AtkStateSet.html#atk-state-set-is-empty" title="atk_state_set_is_empty ()">atk_state_set_is_empty</a>              (AtkStateSet *set);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a class="link" href="atk-AtkStateSet.html#atk-state-set-add-state" title="atk_state_set_add_state ()">atk_state_set_add_state</a>             (AtkStateSet *set,
                                                         <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a> type);
void                <a class="link" href="atk-AtkStateSet.html#atk-state-set-add-states" title="atk_state_set_add_states ()">atk_state_set_add_states</a>            (AtkStateSet *set,
                                                         <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a> *types,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> n_types);
void                <a class="link" href="atk-AtkStateSet.html#atk-state-set-clear-states" title="atk_state_set_clear_states ()">atk_state_set_clear_states</a>          (AtkStateSet *set);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a class="link" href="atk-AtkStateSet.html#atk-state-set-contains-state" title="atk_state_set_contains_state ()">atk_state_set_contains_state</a>        (AtkStateSet *set,
                                                         <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a> type);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a class="link" href="atk-AtkStateSet.html#atk-state-set-contains-states" title="atk_state_set_contains_states ()">atk_state_set_contains_states</a>       (AtkStateSet *set,
                                                         <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a> *types,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> n_types);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a class="link" href="atk-AtkStateSet.html#atk-state-set-remove-state" title="atk_state_set_remove_state ()">atk_state_set_remove_state</a>          (AtkStateSet *set,
                                                         <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a> type);
AtkStateSet*        <a class="link" href="atk-AtkStateSet.html#atk-state-set-and-sets" title="atk_state_set_and_sets ()">atk_state_set_and_sets</a>              (AtkStateSet *set,
                                                         AtkStateSet *compare_set);
AtkStateSet*        <a class="link" href="atk-AtkStateSet.html#atk-state-set-or-sets" title="atk_state_set_or_sets ()">atk_state_set_or_sets</a>               (AtkStateSet *set,
                                                         AtkStateSet *compare_set);
AtkStateSet*        <a class="link" href="atk-AtkStateSet.html#atk-state-set-xor-sets" title="atk_state_set_xor_sets ()">atk_state_set_xor_sets</a>              (AtkStateSet *set,
                                                         AtkStateSet *compare_set);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="atk-AtkStateSet.description"></a><h2>Description</h2>
<p>
An AtkStateSet determines a component's state set. It is composed of a set 
of AtkStates.
</p>
</div>
<div class="refsect1" lang="en">
<a name="atk-AtkStateSet.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="atk-state-set-new"></a><h3>atk_state_set_new ()</h3>
<pre class="programlisting">AtkStateSet*        atk_state_set_new                   (void);</pre>
<p>
Creates a new empty state set.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <span class="type">AtkStateSet</span> 
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-state-set-is-empty"></a><h3>atk_state_set_is_empty ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            atk_state_set_is_empty              (AtkStateSet *set);</pre>
<p>
Checks whether the state set is empty, i.e. has no states set.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
<td> an <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if <em class="parameter"><code>set</code></em> has no states set, otherwise <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-state-set-add-state"></a><h3>atk_state_set_add_state ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            atk_state_set_add_state             (AtkStateSet *set,
                                                         <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a> type);</pre>
<p>
Add a new state for the specified type to the current state set if
it is not already present.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
<td> an <span class="type">AtkStateSet</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> an <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if  the state for <em class="parameter"><code>type</code></em> is not already in <em class="parameter"><code>set</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-state-set-add-states"></a><h3>atk_state_set_add_states ()</h3>
<pre class="programlisting">void                atk_state_set_add_states            (AtkStateSet *set,
                                                         <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a> *types,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> n_types);</pre>
<p>
Add the states for the specified types to the current state set.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
<td> an <span class="type">AtkStateSet</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>types</code></em> :</span></p></td>
<td> an array of <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_types</code></em> :</span></p></td>
<td> The number of elements in the array
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-state-set-clear-states"></a><h3>atk_state_set_clear_states ()</h3>
<pre class="programlisting">void                atk_state_set_clear_states          (AtkStateSet *set);</pre>
<p>
Removes all states from the state set.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
<td> an <span class="type">AtkStateSet</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-state-set-contains-state"></a><h3>atk_state_set_contains_state ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            atk_state_set_contains_state        (AtkStateSet *set,
                                                         <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a> type);</pre>
<p>
Checks whether the state for the specified type is in the specified set.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
<td> an <span class="type">AtkStateSet</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> an <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if <em class="parameter"><code>type</code></em> is the state type is in <em class="parameter"><code>set</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-state-set-contains-states"></a><h3>atk_state_set_contains_states ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            atk_state_set_contains_states       (AtkStateSet *set,
                                                         <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a> *types,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> n_types);</pre>
<p>
Checks whether the states for all the specified types are in the 
specified set.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
<td> an <span class="type">AtkStateSet</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>types</code></em> :</span></p></td>
<td> an array of <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_types</code></em> :</span></p></td>
<td> The number of elements in the array
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if all the states for <em class="parameter"><code>type</code></em> are in <em class="parameter"><code>set</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-state-set-remove-state"></a><h3>atk_state_set_remove_state ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            atk_state_set_remove_state          (AtkStateSet *set,
                                                         <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a> type);</pre>
<p>
Removes the state for the specified type from the state set.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
<td> an <span class="type">AtkStateSet</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> an <span class="type">AtkType</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if <em class="parameter"><code>type</code></em> was the state type is in <em class="parameter"><code>set</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-state-set-and-sets"></a><h3>atk_state_set_and_sets ()</h3>
<pre class="programlisting">AtkStateSet*        atk_state_set_and_sets              (AtkStateSet *set,
                                                         AtkStateSet *compare_set);</pre>
<p>
Constructs the intersection of the two sets, returning <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> if the
intersection is empty.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
<td> an <span class="type">AtkStateSet</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>compare_set</code></em> :</span></p></td>
<td> another <span class="type">AtkStateSet</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <span class="type">AtkStateSet</span> which is the intersection of the two sets.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-state-set-or-sets"></a><h3>atk_state_set_or_sets ()</h3>
<pre class="programlisting">AtkStateSet*        atk_state_set_or_sets               (AtkStateSet *set,
                                                         AtkStateSet *compare_set);</pre>
<p>
Constructs the union of the two sets.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
<td> an <span class="type">AtkStateSet</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>compare_set</code></em> :</span></p></td>
<td> another <span class="type">AtkStateSet</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <span class="type">AtkStateSet</span> which is the union of the two sets,
returning <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> is empty.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-state-set-xor-sets"></a><h3>atk_state_set_xor_sets ()</h3>
<pre class="programlisting">AtkStateSet*        atk_state_set_xor_sets              (AtkStateSet *set,
                                                         AtkStateSet *compare_set);</pre>
<p>
Constructs the exclusive-or of the two sets, returning <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> is empty.
The set returned by this operation contains the states in exactly
one of the two sets.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
<td> an <span class="type">AtkStateSet</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>compare_set</code></em> :</span></p></td>
<td> another <span class="type">AtkStateSet</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <span class="type">AtkStateSet</span> which contains the states which are 
in exactly one of the two sets.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.10</div>
</body>
</html>
